Fixes #37664 - switch to using js-cookie #10250

MariaAga · 2024-07-18T18:54:53Z

replaces jquery.cookie with js-cookie, as jquery.cookie has moved to js-cookie

MariaAga · 2024-07-18T18:55:13Z

Should I try to create a packaging PR as well for this? @theforeman/packaging

ekohl · 2024-07-18T19:48:49Z

app/assets/javascripts/application.js

@@ -81,7 +82,7 @@ function onContentLoad() {

  tfm.i18n.intl.ready.then(function() {
    var tz = jstz.determine();
-    $.cookie('timezone', tz.name(), {
+    Cookies.set('timezone', tz.name(), {


In other places we use tfm to pull in code from webpack. If we do that, I think we can avoid the Ruby dependency on js_cookie_rails.

I actually wonder why we need the timezone cookie. Some of my digging.

It was added in ad998ce. There it has set_timezone in app/controllers/concerns/application_shared.rb but that was moved to app/controllers/concerns/foreman/controller/timezone.rb in d1e1858. That makes me think it's still used. A quick look on the internet tells me this design is still a best practice.

Having said that: tfm.i18n.intl.ready looks to be coming from webpack code so you can also consider moving the whole cookie setting code to webpack.

its used in rubys set_timezone.
I moved it to webpack

bundler.d/assets.rb

ekohl

If you want to take a stab at packaging then please

MariaAga · 2024-07-22T10:10:38Z

Added packaging pr theforeman/foreman-packaging#11048

MariaAga · 2024-07-22T13:51:23Z

Added it to tfm as well as some plugins are using it

ekohl

Did you have a look at the test failure? I think I've seen that one pop up in multiple tests but haven't looked into it yet.

MariaAga · 2024-07-23T07:06:48Z

Yeah I see test_0002_correctly override global params fail on some prs and cant reproduce it locally

ekohl · 2024-07-23T07:11:29Z

I bet it'll turn out to be some nasty race condition or theforeman/actions#53

MariaAga · 2024-09-03T14:15:38Z

Rebased

jeremylenz

Ran npm install and tested

_ForemanSelectedhosts cookie value is updated as expected. LGTM 👍

adamruzicka · 2024-10-22T07:26:05Z

/packit build

adamruzicka · 2024-10-22T07:49:10Z

The packit build failures will probably need more changes here

+ /usr/bin/rake webpack:compile DATABASE_URL=nulldb://nohost
2024-10-22T07:28:51 [I|app|] Rails cache backend: File
2024-10-22T07:28:51 [W|app|] You are trying to replace import_subnets from . Adding allowed actions from plugin permissions to the existing one.
npx --max_old_space_size=2048 webpack --config /builddir/build/BUILD/foreman-3.13.0/config/webpack.config.js --bail
[webpack-cli] ModuleNotFoundError: Module not found: Error: Can't resolve 'js-cookie' in '/builddir/build/BUILD/foreman-3.13.0/webpack/assets/javascripts'
    at /usr/lib/node_modules/webpack/lib/Compilation.js:2029:28
    at /usr/lib/node_modules/webpack/lib/NormalModuleFactory.js:817:13
    at eval (eval at create (/usr/lib/node_modules/webpack/node_modules/tapable/lib/HookCodeFactory.js:33:10), <anonymous>:10:1)
    at /usr/lib/node_modules/webpack/lib/NormalModuleFactory.js:275:22
    at eval (eval at create (/usr/lib/node_modules/webpack/node_modules/tapable/lib/HookCodeFactory.js:33:10), <anonymous>:9:1)
    at /usr/lib/node_modules/webpack/lib/NormalModuleFactory.js:448:22
    at /usr/lib/node_modules/webpack/lib/NormalModuleFactory.js:118:11
    at /usr/lib/node_modules/webpack/lib/NormalModuleFactory.js:689:25
    at /usr/lib/node_modules/webpack/lib/NormalModuleFactory.js:893:8
    at /usr/lib/node_modules/webpack/lib/NormalModuleFactory.js:1013:5
    at /usr/lib/node_modules/webpack/node_modules/neo-async/async.js:6883:13
    at /usr/lib/node_modules/webpack/lib/NormalModuleFactory.js:996:45
    at finishWithoutResolve (/usr/lib/node_modules/webpack/node_modules/enhanced-resolve/lib/Resolver.js:372:11)
    at /usr/lib/node_modules/webpack/node_modules/enhanced-resolve/lib/Resolver.js:461:15
    at /usr/lib/node_modules/webpack/node_modules/enhanced-resolve/lib/Resolver.js:519:5
    at eval (eval at create (/usr/lib/node_modules/webpack/node_modules/tapable/lib/HookCodeFactory.js:33:10), <anonymous>:15:1)
    at /usr/lib/node_modules/webpack/node_modules/enhanced-resolve/lib/Resolver.js:519:5
    at eval (eval at create (/usr/lib/node_modules/webpack/node_modules/tapable/lib/HookCodeFactory.js:33:10), <anonymous>:27:1)
    at /usr/lib/node_modules/webpack/node_modules/enhanced-resolve/lib/DescriptionFilePlugin.js:89:43
    at /usr/lib/node_modules/webpack/node_modules/enhanced-resolve/lib/Resolver.js:519:5
    at eval (eval at create (/usr/lib/node_modules/webpack/node_modules/tapable/lib/HookCodeFactory.js:33:10), <anonymous>:16:1)
    at /usr/lib/node_modules/webpack/node_modules/enhanced-resolve/lib/forEachBail.js:39:13
    at /usr/lib/node_modules/webpack/node_modules/enhanced-resolve/lib/AliasPlugin.js:148:14
    at next (/usr/lib/node_modules/webpack/node_modules/enhanced-resolve/lib/forEachBail.js:35:3)
    at forEachBail (/usr/lib/node_modules/webpack/node_modules/enhanced-resolve/lib/forEachBail.js:49:9)
    at /usr/lib/node_modules/webpack/node_modules/enhanced-resolve/lib/AliasPlugin.js:61:5
    at _next0 (eval at create (/usr/lib/node_modules/webpack/node_modules/tapable/lib/HookCodeFactory.js:33:10), <anonymous>:8:1)
    at eval (eval at create (/usr/lib/node_modules/webpack/node_modules/tapable/lib/HookCodeFactory.js:33:10), <anonymous>:30:1)
    at /usr/lib/node_modules/webpack/node_modules/enhanced-resolve/lib/Resolver.js:519:5
    at eval (eval at create (/usr/lib/node_modules/webpack/node_modules/tapable/lib/HookCodeFactory.js:33:10), <anonymous>:16:1)
    at /usr/lib/node_modules/webpack/node_modules/enhanced-resolve/lib/Resolver.js:519:5
    at eval (eval at create (/usr/lib/node_modules/webpack/node_modules/tapable/lib/HookCodeFactory.js:33:10), <anonymous>:16:1)
    at /usr/lib/node_modules/webpack/node_modules/enhanced-resolve/lib/Resolver.js:519:5
    at eval (eval at create (/usr/lib/node_modules/webpack/node_modules/tapable/lib/HookCodeFactory.js:33:10), <anonymous>:27:1)
    at /usr/lib/node_modules/webpack/node_modules/enhanced-resolve/lib/DescriptionFilePlugin.js:89:43
    at /usr/lib/node_modules/webpack/node_modules/enhanced-resolve/lib/Resolver.js:519:5
    at eval (eval at create (/usr/lib/node_modules/webpack/node_modules/tapable/lib/HookCodeFactory.js:33:10), <anonymous>:16:1)
    at /usr/lib/node_modules/webpack/node_modules/enhanced-resolve/lib/Resolver.js:519:5
    at eval (eval at create (/usr/lib/node_modules/webpack/node_modules/tapable/lib/HookCodeFactory.js:33:10), <anonymous>:15:1)
    at /usr/lib/node_modules/webpack/node_modules/enhanced-resolve/lib/DirectoryExistsPlugin.js:41:15
    at process.processTicksAndRejections (node:internal/process/task_queues:81:21)
resolve 'js-cookie' in '/builddir/build/BUILD/foreman-3.13.0/webpack/assets/javascripts'
  Parsed request is a module
  using description file: /builddir/build/BUILD/foreman-3.13.0/package.json (relative path: ./webpack/assets/javascripts)
    Field 'browser' doesn't contain a valid alias configuration
    resolve as module
      /builddir/build/BUILD/foreman-3.13.0/webpack/assets/javascripts/node_modules doesn't exist or is not a directory
      /builddir/build/BUILD/foreman-3.13.0/webpack/assets/node_modules doesn't exist or is not a directory
      /builddir/build/BUILD/foreman-3.13.0/webpack/node_modules doesn't exist or is not a directory
      looking for modules in /builddir/build/BUILD/foreman-3.13.0/node_modules
        single file module
          using description file: /builddir/build/BUILD/foreman-3.13.0/package.json (relative path: ./node_modules/js-cookie)
            no extension
              Field 'browser' doesn't contain a valid alias configuration
              /builddir/build/BUILD/foreman-3.13.0/node_modules/js-cookie doesn't exist
            .js
              Field 'browser' doesn't contain a valid alias configuration
              /builddir/build/BUILD/foreman-3.13.0/node_modules/js-cookie.js doesn't exist
            .json
              Field 'browser' doesn't contain a valid alias configuration
              /builddir/build/BUILD/foreman-3.13.0/node_modules/js-cookie.json doesn't exist
            .wasm
              Field 'browser' doesn't contain a valid alias configuration
              /builddir/build/BUILD/foreman-3.13.0/node_modules/js-cookie.wasm doesn't exist
        /builddir/build/BUILD/foreman-3.13.0/node_modules/js-cookie doesn't exist
      /builddir/build/BUILD/node_modules doesn't exist or is not a directory
      /builddir/build/node_modules doesn't exist or is not a directory
      /builddir/node_modules doesn't exist or is not a directory
      /node_modules doesn't exist or is not a directory
rake aborted!
Command failed with status (2): [npx --max_old_space_size=2048 webpack --co...]
/builddir/build/BUILD/foreman-3.13.0/lib/tasks/webpack_compile.rake:18:in `block (2 levels) in <top (required)>'
/usr/share/gems/gems/rake-13.0.3/exe/rake:27:in `<top (required)>'
Tasks: TOP => webpack:compile
(See full trace by running task with --trace)
error: Bad exit status from /var/tmp/rpm-tmp.0uyi44 (%build)
    Bad exit status from /var/tmp/rpm-tmp.0uyi44 (%build)

ehelms · 2024-10-23T13:24:02Z

This change will require a specfile update (new dependency), and thus I don't think the packit build step will ever pass on the PR.

MariaAga · 2024-10-23T13:32:12Z

@ehelms doesnt the packaging update (was merged already) take care of that?

ehelms · 2024-10-23T13:57:09Z

@ehelms doesnt the packaging update (was merged already) take care of that?

The packaging PR (https://github.com/theforeman/foreman-packaging/pull/11048/files) adds the package but does not update Foreman to require the package. Thus it does not get pulled in during build time and the above error occurs. This is a bit of a chicken and egg problem. We do not update the spec with new dependencies until the code has the dependency merged, but RPM builds will fail until we update the spec with the new build. We tend to just accept that packit will fail in this case and that's OK.

ekohl · 2024-10-23T15:49:25Z

The packaging PR (https://github.com/theforeman/foreman-packaging/pull/11048/files) adds the package but does not update Foreman to require the package. Thus it does not get pulled in during build time and the above error occurs. This is a bit of a chicken and egg problem. We do not update the spec with new dependencies until the code has the dependency merged, but RPM builds will fail until we update the spec with the new build. We tend to just accept that packit will fail in this case and that's OK.

theforeman/foreman-packaging#8414 intends to solve that by dynamically generating the build requires. We're working on dropping EL8, which was a blocker to using this. I also need to write the NodeJS side of it, but I don't expect to wrap that up in time for this PR.

adamruzicka

One question to make sure I'm putting the pieces together the right way in my mind and one to get some notion about how this used to work. Overall lgtm

webpack/assets/javascripts/bundle.js

webpack/assets/javascripts/react_app/common/I18n.js

adamruzicka · 2024-11-12T13:54:05Z

Also, plugins will still be able to use it the old way until we drop jquery completely, correct?

MariaAga · 2024-11-12T14:18:53Z

Yes, but I tried to catch the only plugin that used it here: theforeman/foreman_openscap#576

adamruzicka · 2024-11-26T09:25:30Z

Thank you everyone

MariaAga requested a review from a team as a code owner July 18, 2024 18:54

pr-processor bot added the Not yet reviewed label Jul 18, 2024

github-actions bot added UI Legacy JS PRs making changes in the legacy Javascript stack labels Jul 18, 2024

MariaAga mentioned this pull request Jul 18, 2024

Fixes #37382 - Update to jQuery 3 #10138

Open

ekohl requested changes Jul 18, 2024

View reviewed changes

pr-processor bot added Waiting on contributor and removed Not yet reviewed labels Jul 18, 2024

MariaAga force-pushed the add-js-cookie-37382 branch from cca3247 to 1477aa4 Compare July 19, 2024 09:37

pr-processor bot added Needs re-review and removed Waiting on contributor labels Jul 19, 2024

MariaAga force-pushed the add-js-cookie-37382 branch from 1477aa4 to c90eb44 Compare July 19, 2024 09:39

ekohl previously approved these changes Jul 19, 2024

View reviewed changes

pr-processor bot removed the Needs re-review label Jul 19, 2024

MariaAga dismissed ekohl’s stale review via 7ba72c5 July 22, 2024 13:34

MariaAga force-pushed the add-js-cookie-37382 branch from c90eb44 to 7ba72c5 Compare July 22, 2024 13:34

MariaAga mentioned this pull request Jul 22, 2024

Fixes #37673 - Refactor deprecated jquery functions theforeman/foreman_openscap#576

Open

ekohl reviewed Jul 22, 2024

View reviewed changes

MariaAga mentioned this pull request Jul 23, 2024

feat(vendor-core): update to jquery 3 theforeman/foreman-js#479

Open

MariaAga requested a review from jeremylenz August 13, 2024 19:14

Fixes #37664 - switch to using js-cookie

c842625

MariaAga force-pushed the add-js-cookie-37382 branch from 7ba72c5 to c842625 Compare September 3, 2024 14:15

jeremylenz approved these changes Oct 21, 2024

View reviewed changes

MariaAga requested a review from jeremylenz November 12, 2024 12:02

adamruzicka approved these changes Nov 12, 2024

View reviewed changes

webpack/assets/javascripts/bundle.js Show resolved Hide resolved

webpack/assets/javascripts/react_app/common/I18n.js Show resolved Hide resolved

adamruzicka removed the request for review from jeremylenz November 26, 2024 09:05

evgeni approved these changes Nov 26, 2024

View reviewed changes

adamruzicka merged commit 8e97632 into theforeman:develop Nov 26, 2024
61 of 66 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fixes #37664 - switch to using js-cookie #10250

Fixes #37664 - switch to using js-cookie #10250

MariaAga commented Jul 18, 2024

MariaAga commented Jul 18, 2024

ekohl Jul 18, 2024

MariaAga Jul 19, 2024

ekohl left a comment

MariaAga commented Jul 22, 2024

MariaAga commented Jul 22, 2024

ekohl left a comment

MariaAga commented Jul 23, 2024

ekohl commented Jul 23, 2024

MariaAga commented Sep 3, 2024

jeremylenz left a comment

adamruzicka commented Oct 22, 2024

adamruzicka commented Oct 22, 2024

ehelms commented Oct 23, 2024

MariaAga commented Oct 23, 2024

ehelms commented Oct 23, 2024

ekohl commented Oct 23, 2024

adamruzicka left a comment

adamruzicka commented Nov 12, 2024

MariaAga commented Nov 12, 2024

adamruzicka commented Nov 26, 2024

Fixes #37664 - switch to using js-cookie #10250

Fixes #37664 - switch to using js-cookie #10250

Conversation

MariaAga commented Jul 18, 2024

MariaAga commented Jul 18, 2024

ekohl Jul 18, 2024

Choose a reason for hiding this comment

MariaAga Jul 19, 2024

Choose a reason for hiding this comment

ekohl left a comment

Choose a reason for hiding this comment

MariaAga commented Jul 22, 2024

MariaAga commented Jul 22, 2024

ekohl left a comment

Choose a reason for hiding this comment

MariaAga commented Jul 23, 2024

ekohl commented Jul 23, 2024

MariaAga commented Sep 3, 2024

jeremylenz left a comment

Choose a reason for hiding this comment

adamruzicka commented Oct 22, 2024

adamruzicka commented Oct 22, 2024

ehelms commented Oct 23, 2024

MariaAga commented Oct 23, 2024

ehelms commented Oct 23, 2024

ekohl commented Oct 23, 2024

adamruzicka left a comment

Choose a reason for hiding this comment

adamruzicka commented Nov 12, 2024

MariaAga commented Nov 12, 2024

adamruzicka commented Nov 26, 2024