namespace all apicast source code #486
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
* to not have too many things named apicast * because that directory will include another apicast folder with lua sources * `apicast/apicast/src/apicast` would look really silly
* all related files to the cli should be in `apicast/cli`
mikz
force-pushed
the
rename-global-namespace
branch
3 times, most recently
from
73e7c53 to
1ce43dc
Compare
mikz
changed the title
so we don't pollute global namespace with files and prevent clashes when new dependencies are installed
this is going to be a breaking change for policies that previously required apicast policy
mikz
force-pushed
the
rename-global-namespace
branch
from
1ce43dc to
acb0fba
Compare
davidor
reviewed
Nov 21, 2017
| @@ -0,0 +1,51 @@ | |||
| local loadfile = loadfile | |||
There was a problem hiding this comment.
I think It would be good to document the purpose of this module.
There was a problem hiding this comment.
Should be addressed in b1d677a.
mikz
force-pushed
the
rename-global-namespace
branch
from
acb0fba to
109e5cb
Compare
davidor
reviewed
Nov 21, 2017
t/deprecation-warnings.t
Outdated
|
|
||
| __DATA__ | ||
|
|
||
| === TEST 1: authentication credentials missing |
There was a problem hiding this comment.
I'd change the title and description of the test so they make reference to what is actually being tested here.
There was a problem hiding this comment.
hah, yeah my copy paste issue
well spotted
davidor
approved these changes
Nov 21, 2017
* custom loader can try to load files from new paths even when the caller code refers to the old ones * print deprecation warnings with suggestions how to fix them
* makes it way easier in tests to not stub upstream
mikz
force-pushed
the
rename-global-namespace
branch
from
109e5cb to
a12a22c
Compare
mikz
added a commit
that referenced
this pull request
Nov 21, 2017
This was referenced Nov 21, 2017
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
tl;dr
From now instead of
require('policy')userequire('apicast.policy'). All APIcast source code is in theapicastnamespace.Right now APIcast is polluting global namespace with its source files.
As more dependencies are installed there is higher chance of a clash.
So we need to namespace all APIcast source code in
apicastfolder insidethe Lua load path.
To prevent weird paths like
apicast/apicast/src/apicastthis also renames thefolder that contains all APIcast distributed source from
apicasttogateway.Print deprecation warnings when old code refers to new paths:
Please note the benchmark does not work because the new configuration is not compatible with the old one. But the old one should be compatible with the new one.
Also note that if someone was overriding a path of APIcast then it will stop working after this change.
Requiring old files continue to work with a deprecation warning, but overriding those files on old paths
will not be taken into effect in the APIcast codebase. This is potential BREAKING CHANGE for some customizations.
Another interesting change is the echo policy. Now it short circuits the upstream api and responds directly in the rewrite phase stopping everything else.
/cc @3scale/support