All maximum number of rendered asciidoc documents on one page to be configurable
Summary
We have a lot of documentation across multiple .asciidoc files, and we also have one .asciidoc file which imports all other files (let’s call that file the main file). The purpose of this main file is to group and render complete documentation from one .asciidoc. When this file is rendered in Gitlab, first x links are rendered normally (e.g. text, images, formatting is normally rendered). From x+1 link, nothing is rendered, and only clickable links are displayed which open .asciidoc. Opened .asciidoc is not rendered but source of the file is displayed, and nothing else (no left-side menu, navigation bar, nothing which is usually rendered when on wiki). If page that is linked is manually searched and clicked, page is rendered normally (and left-side menu, navigation bar, etc is displayed).
Has anyone encountered with such issue or have we did something wrong at our side? Or is there some sort of maximum chars to render or maximum number of links per page? We are self hosting Gitlab (free plan), and are currently on version 12.10.1-ee (we update it every month or so).
Steps to reproduce
This main file contains imports to 100 other asciidoc files, but only first 32 are displayed correctly. After that, only links are displayed. We tried removing first 32 imports (because they are displayed correctly to eliminate any bug in documentation itself), but that resulted with correct rendering of next 32 files.
What is the current bug behavior?
Only first x linked documents are rendered correctly.
What is the expected correct behavior?
All linked .asciidoc files should be rendered correctly on one main page.
Relevant logs and/or screenshots
This is the start of the main page with first 32 links rendered correctly:
And after 32 links were rendered correctly and without any flaw, Gitlab stopped rendering other documents
I am also posting the portion of the “source code” of main page to show that all files before and after chapter 32 are included in the same way.
Output of checks
Results of GitLab environment info
Expand for output related to GitLab environment info
System information System: Proxy: no Current User: git Using RVM: no Ruby Version: 2.6.5p114 Gem Version: 2.7.10 Bundler Version:1.17.3 Rake Version: 12.3.3 Redis Version: 5.0.7 Git Version: 2.26.2 Sidekiq Version:5.2.7 Go Version: unknown GitLab information Version: 12.10.1-ee Revision: 695c29abcf7 Directory: /opt/gitlab/embedded/service/gitlab-rails DB Adapter: PostgreSQL DB Version: 11.7 URL: https://gitlab.vestigo.hr HTTP Clone URL: https://gitlab.vestigo.hr/some-group/some-project.git SSH Clone URL: git@gitlab.vestigo.hr:some-group/some-project.git Elasticsearch: no Geo: no Using LDAP: yes Using Omniauth: yes Omniauth Providers: GitLab Shell Version: 12.2.0 Repository storage paths: - default: /var/opt/gitlab/git-data/repositories GitLab Shell path: /opt/gitlab/embedded/service/gitlab-shell Git: /opt/gitlab/embedded/bin/git
Results of GitLab application Check
Expand for output related to the GitLab application check
Checking GitLab subtasks ...Checking GitLab Shell ...
GitLab Shell: ... GitLab Shell version >= 12.2.0 ? ... OK (12.2.0) Running /opt/gitlab/embedded/service/gitlab-shell/bin/check Internal API available: OK Redis available via internal API: OK gitlab-shell self-check successful
Checking GitLab Shell ... Finished
Checking Gitaly ...
Gitaly: ... default ... OK
Checking Gitaly ... Finished
Checking Sidekiq ...
Sidekiq: ... Running? ... yes Number of Sidekiq processes ... 1
Checking Sidekiq ... Finished
Checking Incoming Email ...
Incoming Email: ... Reply by email is disabled in config/gitlab.yml
Checking Incoming Email ... Finished
Checking LDAP ...
LDAP: ... Server: ldapmain LDAP authentication... Success LDAP users with access to your GitLab server (only showing the first 100 results) User output sanitized. Found 100 users of 100 limit.
Checking LDAP ... Finished
Checking GitLab App ...
Git configured correctly? ... yes Database config exists? ... yes All migrations up? ... yes Database contains orphaned GroupMembers? ... no GitLab config exists? ... yes GitLab config up to date? ... yes Log directory writable? ... yes Tmp directory writable? ... yes Uploads directory exists? ... yes Uploads directory has correct permissions? ... yes Uploads directory tmp has correct permissions? ... yes Init script exists? ... skipped (omnibus-gitlab has no init script) Init script up-to-date? ... skipped (omnibus-gitlab has no init script) Projects have namespace: ... 3/2 ... yes 3/3 ... yes 3/11 ... yes 3/12 ... yes Redis version >= 4.0.0? ... yes Ruby version >= 2.5.3 ? ... yes (2.6.5) Git version >= 2.22.0 ? ... yes (2.26.2) Git user has default SSH configuration? ... yes Active users: ... 9 Is authorized keys file accessible? ... yes Elasticsearch version 5.6 - 6.x? ... skipped (elasticsearch is disabled)
Checking GitLab App ... Finished
Checking GitLab subtasks ... Finished
Testing Activity
- Test with default and custom limits.
- Unit tests of application settings and Gitlab::Asciidoc
- Test system would render the number of asciidoc documents specified by system setting
MR Breakdown
- We currently have a hard-coded constant, this needs to be replaced by a dynamic value from the DB.
- 1 MR to introduce the new setting
- Optionally another MR to expose it in the admin UI
- New application setting for asciidoc include limit
- Update Gitlab::Asciidoc to use new limit
- I think this should be a system setting for now, just to ensure Gitlab.com still can perform well.