common-controller-scripts.js: Convert "script" to freezed object, and remove global "controller", "deck", "control", "button" definitions #11625

JoergAtGithub · 2023-06-04T16:02:07Z

Silenced eslint warnings vor unused vars
Use console.log instead of deprecated print function
Made global functions const.

…yntax Silenced eslint warnings or unused vars

…ToES2015Classes

daschuer

LGTM, However I am unable to test this.
Can we risk to merge it and see what happens during the remaining 5 Weeks beta?

JoergAtGithub · 2023-07-02T11:33:34Z

I think it's unecessary risk for 2.4 now.

github-actions · 2023-10-04T00:07:14Z

This PR is marked as stale because it has been open 90 days with no activity.

daschuer · 2024-05-08T05:57:35Z

Oh sorry this one slipped through. Can you fix the conflicts and than we can merge?

…nToES2015Classes

daschuer · 2024-06-02T10:04:49Z

CI fails. I like to move this either to 2.5.0 or 2.6-alpha milestone. Does this have an impact on mapping interface regarding documentation?

JoergAtGithub · 2024-06-02T11:46:12Z

No impact on documentation. I currently don't know how to fix this.

christophehenry · 2024-07-16T07:16:12Z

Let's wait for the end of the CI but I believe ac4ab33 solves this CI error. At least it solves it locally here. I think the error comes from that const declarations do not create properties on globalThis when declared at the top level of a script. so const script won't dump script into the global namespace. I enclosed the whole code into a (function(global) { … }(this)); to solve this.
I also changed script's method definitions to ES6 methods synctatic sugar.

I don't know why reverting to var didn't solve the problem, though.

Edit: yup, that fixes the tests. You can cherry pick ac4ab335b5831f7d1e2a885c7d014b04e3e8c2bd.

Swiftb0y · 2024-07-16T15:15:54Z

Great. Thanks for investigating.

JoergAtGithub · 2024-07-16T18:02:00Z

Unfortunately the (function(global) { … }(this)); breaks the IDE support for me. Not a single symbol from common-controller-scripts.js is recognized anymore and I get spamed with errors.

JoergAtGithub · 2024-07-16T21:55:50Z

Now everything is Pass!
The reason was that variable objects in JavaScript exist from the start - as undefined, while const objects do not exist before completion of their initialization.
The function script.deepMerge contains recursive calls of itself. While initializing script.deepMerge it fails, because the recursive called function script.deepMerge does not exist yet.

Swiftb0y · 2024-07-17T10:30:13Z

great. the only remaining comments are the ones from above suggesting the use of default parameters. Have you looked into that?

EDIT: I just double-checked myself. It does support default parameters. So it be nice to see them used in the spots highlighted.

JoergAtGithub · 2024-07-18T07:09:42Z

Done!

christophehenry · 2024-07-22T07:13:42Z

res/controllers/common-controller-scripts.js

+    }
+}
+// Add instance bpm of bpmClass to the Global JavaScript object
+this.bpm = new bpmClass();


Why didn't you keep the IIFE in my fix?

iiuc because it broke editor support for Joerg.

What about using JSDoc's @global?

Suggested change

this.bpm = new bpmClass();

(function(global){

class bpmClass { … }

/** @global */

const bpm = new bpmClass();

…

global.bpm = bpm;

})(this);

I used it here. @JoergAtGithub did it do the trick for you?

I just tried it again, with the proposed code the symbol bpm becomes invisible outside of the function statement. Neither code completion, pop-up help nor type checking work anymore. While with the code of this PR everything works.
this.bpm = new bpmClass(); is not a new code pattern, it's already used in the hid-parser of 2.4 and seems to work for everybody.

Weird. But ok then.

Edit: but you don't have any problem with Lodash? 🤔

Swiftb0y · 2024-07-23T11:45:00Z

res/controllers/common-controller-scripts.js

+const colorCodeFromObject = function(color) {
    return ((color.red & 0xFF) << 16 | (color.green & 0xFF) << 8 | (color.blue & 0xFF));
 };


did you double check the const here didn't break anything?

Swiftb0y · 2024-08-12T15:01:38Z

res/controllers/common-controller-scripts.js

+// @ts-ignore Same identifier for class and instance needed for backward compatibility
+class bpmClass {


Suggested change

// @ts-ignore Same identifier for class and instance needed for backward compatibility

class bpmClass {

class bpmClass {

I also just noticed that we now have [ChannelN],tempo_tap which essentially deprecates script.bpm, right? cc @ronso0

github-actions bot added the controller mappings label Jun 4, 2023

JoergAtGithub changed the title ~~common-controller-scripts.js: Convert empty function to es2015 classe syntax~~ common-controller-scripts.js: Convert empty function to es2015 class syntax Jun 4, 2023

JoergAtGithub force-pushed the ConvertEmptyFunctionToES2015Classes branch from 180edac to 210248a Compare June 4, 2023 17:42

Changed to ES2015 classes, const functions and used JSDoc deprecate s…

b36c378

…yntax Silenced eslint warnings or unused vars

JoergAtGithub force-pushed the ConvertEmptyFunctionToES2015Classes branch from 210248a to b36c378 Compare June 4, 2023 18:27

Merge remote-tracking branch 'upstream/2.4' into ConvertEmptyFunction…

cedcda9

…ToES2015Classes

daschuer approved these changes Jul 2, 2023

View reviewed changes

JoergAtGithub marked this pull request as draft July 2, 2023 11:34

JoergAtGithub added this to the 2.5.0 milestone Jul 5, 2023

github-actions bot added the stale Stale issues that haven't been updated for a long time. label Oct 4, 2023

ronso0 added controller backend and removed controller mappings labels Feb 20, 2024

github-actions bot removed the stale Stale issues that haven't been updated for a long time. label Feb 22, 2024

Merge remote-tracking branch 'upstream/main' into ConvertEmptyFunctio…

610d4ce

…nToES2015Classes

github-actions bot added skins effects library engine ui build autodj code quality preferences scanner waveform vinylcontrol soundsource labels May 8, 2024

daschuer modified the milestones: 2.5-beta, 2.5.0 Jun 2, 2024

daschuer removed the controllers label Jun 25, 2024

JoergAtGithub mentioned this pull request Jul 15, 2024

Deprecate lodash.mixxx.js, and script.deepMerge #13460

Merged

christophehenry mentioned this pull request Jul 16, 2024

[Ignore] Convert empty function to es2015 classes #13477

Closed

Use var instead of const for script to make script.deepmerge working

8b57df3

JoergAtGithub force-pushed the ConvertEmptyFunctionToES2015Classes branch from 3c59fb1 to d94fffb Compare July 17, 2024 23:10

Changed script's method definitions to ES6 methods

acb1d93

JoergAtGithub force-pushed the ConvertEmptyFunctionToES2015Classes branch from 4f3a8af to acb1d93 Compare July 18, 2024 06:23

JoergAtGithub force-pushed the ConvertEmptyFunctionToES2015Classes branch 2 times, most recently from e314d95 to 12e8bc1 Compare July 18, 2024 16:24

JoergAtGithub added 5 commits July 18, 2024 18:39

Refactored arrayContains

8153113

Use default values and further optimization

ca59e06

Optimized String.prototype.toInt

fcff02a

Fix tslint warnings

45feddc

Mark script.deepMerge as deprecated

dbe9a26

JoergAtGithub force-pushed the ConvertEmptyFunctionToES2015Classes branch from ec64440 to dbe9a26 Compare July 18, 2024 16:40

JSDoc

0b22ff0

christophehenry reviewed Jul 22, 2024

View reviewed changes

Swiftb0y reviewed Jul 23, 2024

View reviewed changes

Swiftb0y reviewed Aug 12, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

common-controller-scripts.js: Convert "script" to freezed object, and remove global "controller", "deck", "control", "button" definitions #11625

common-controller-scripts.js: Convert "script" to freezed object, and remove global "controller", "deck", "control", "button" definitions #11625

JoergAtGithub commented Jun 4, 2023 •

edited

Loading

daschuer left a comment

JoergAtGithub commented Jul 2, 2023

github-actions bot commented Oct 4, 2023

daschuer commented May 8, 2024

daschuer commented Jun 2, 2024

JoergAtGithub commented Jun 2, 2024

christophehenry commented Jul 16, 2024 •

edited

Loading

Swiftb0y commented Jul 16, 2024

JoergAtGithub commented Jul 16, 2024

JoergAtGithub commented Jul 16, 2024

Swiftb0y commented Jul 17, 2024 •

edited

Loading

JoergAtGithub commented Jul 18, 2024

christophehenry Jul 22, 2024

Swiftb0y Jul 23, 2024

christophehenry Jul 23, 2024 •

edited

Loading

JoergAtGithub Jul 24, 2024

christophehenry Jul 24, 2024 •

edited

Loading

Swiftb0y Jul 23, 2024

Swiftb0y Aug 12, 2024

-this.bpm = new bpmClass();
+(function(global){
+class bpmClass { … }
+/** @global */
+const bpm = new bpmClass();
+…
+global.bpm = bpm;
+})(this);

		// @ts-ignore Same identifier for class and instance needed for backward compatibility
		class bpmClass {

common-controller-scripts.js: Convert "script" to freezed object, and remove global "controller", "deck", "control", "button" definitions #11625

Are you sure you want to change the base?

common-controller-scripts.js: Convert "script" to freezed object, and remove global "controller", "deck", "control", "button" definitions #11625

Conversation

JoergAtGithub commented Jun 4, 2023 • edited Loading

daschuer left a comment

Choose a reason for hiding this comment

JoergAtGithub commented Jul 2, 2023

github-actions bot commented Oct 4, 2023

daschuer commented May 8, 2024

daschuer commented Jun 2, 2024

JoergAtGithub commented Jun 2, 2024

christophehenry commented Jul 16, 2024 • edited Loading

Swiftb0y commented Jul 16, 2024

JoergAtGithub commented Jul 16, 2024

JoergAtGithub commented Jul 16, 2024

Swiftb0y commented Jul 17, 2024 • edited Loading

JoergAtGithub commented Jul 18, 2024

christophehenry Jul 22, 2024

Choose a reason for hiding this comment

Swiftb0y Jul 23, 2024

Choose a reason for hiding this comment

christophehenry Jul 23, 2024 • edited Loading

Choose a reason for hiding this comment

JoergAtGithub Jul 24, 2024

Choose a reason for hiding this comment

christophehenry Jul 24, 2024 • edited Loading

Choose a reason for hiding this comment

Swiftb0y Jul 23, 2024

Choose a reason for hiding this comment

Swiftb0y Aug 12, 2024

Choose a reason for hiding this comment

JoergAtGithub commented Jun 4, 2023 •

edited

Loading

christophehenry commented Jul 16, 2024 •

edited

Loading

Swiftb0y commented Jul 17, 2024 •

edited

Loading

christophehenry Jul 23, 2024 •

edited

Loading

christophehenry Jul 24, 2024 •

edited

Loading