[PATCH] services: nginx: Support extra content in the http block.

Done

Details

2 participants

Ludovic Courtès
Christopher Baines

Owner: unassigned

Submitted by: Christopher Baines

Severity: normal

Debbugs page

Christopher Baines wrote 7 years ago

Recipients:(address . guix-patches@gnu.org)

Message-ID:20180304200014.29173-1-mail@cbaines.net

This helpful when adding content to the nginx configuration file, which isn't
supported by the record type used for the configuration.  For example, like
adding proxy_cache_path configuration.

* gnu/packages/web.scm (<nginx-configuration>): Add new extra-content field.
  (nginx-configuration-extra-content): New field accessor.
  (default-nginx-config): Add support for the extra-content field.
* doc/guix.texi (NGINX): Document the new extra-content field.
---
 doc/guix.texi        | 4 ++++
 gnu/services/web.scm | 9 +++++++--
 2 files changed, 11 insertions(+), 2 deletions(-)

Toggle diff (58 lines)diff --git a/doc/guix.texi b/doc/guix.texi
index 057272df4..151bc7ddd 100644
--- a/doc/guix.texi
+++ b/doc/guix.texi
@@ -15431,6 +15431,10 @@ use the size of the processors cache line.
 @item @code{server-names-hash-bucket-max-size} (default: @code{#f})
 Maximum bucket size for the server names hash tables.
 
+@item @code{extra-content} (default: @code{'()})
+Extra content for the @code{http} block.  Should be a list of strings or
+G-expressions.
+
 @end table
 @end deffn
 
diff --git a/gnu/services/web.scm b/gnu/services/web.scm
index beda481b0..1f58c9b86 100644
--- a/gnu/services/web.scm
+++ b/gnu/services/web.scm
@@ -73,6 +73,7 @@
             nginx-configuration-upstream-blocks
             nginx-configuration-server-names-hash-bucket-size
             nginx-configuration-server-names-hash-bucket-max-size
+            nginx-configuration-extra-content
             nginx-configuration-file
 
             <nginx-server-configuration>
@@ -423,6 +424,8 @@
                                  (default #f))
   (server-names-hash-bucket-max-size nginx-configuration-server-names-hash-bucket-max-size
                                      (default #f))
+  (extra-content nginx-configuration-extra-content
+                 (default '()))
   (file          nginx-configuration-file         ;#f | string | file-like
                  (default #f)))
 
@@ -513,7 +516,8 @@ of index files."
                 (nginx log-directory run-directory
                  server-blocks upstream-blocks
                  server-names-hash-bucket-size
-                 server-names-hash-bucket-max-size)
+                 server-names-hash-bucket-max-size
+                 extra-content)
    (apply mixed-text-file "nginx.conf"
           (flatten
            "user nginx nginx;\n"
@@ -542,7 +546,8 @@ of index files."
            "\n"
            (map emit-nginx-upstream-config upstream-blocks)
            (map emit-nginx-server-config server-blocks)
-           "}\n"
+           extra-content
+           "\n}\n"
            "events {}\n"))))
 
 (define %nginx-accounts
-- 
2.16.0

Ludovic Courtès wrote 7 years ago

Recipients:(name . Christopher Baines)(address . mail@cbaines.net)(address . 30702@debbugs.gnu.org)

Message-ID:87h8pel6q6.fsf@gnu.org

Hello,

Christopher Baines <mail@cbaines.net> skribis:

Toggle quote (25 lines)> This helpful when adding content to the nginx configuration file, which isn't
> supported by the record type used for the configuration.  For example, like
> adding proxy_cache_path configuration.
>
> * gnu/packages/web.scm (<nginx-configuration>): Add new extra-content field.
>   (nginx-configuration-extra-content): New field accessor.
>   (default-nginx-config): Add support for the extra-content field.
> * doc/guix.texi (NGINX): Document the new extra-content field.
> ---
>  doc/guix.texi        | 4 ++++
>  gnu/services/web.scm | 9 +++++++--
>  2 files changed, 11 insertions(+), 2 deletions(-)
>
> diff --git a/doc/guix.texi b/doc/guix.texi
> index 057272df4..151bc7ddd 100644
> --- a/doc/guix.texi
> +++ b/doc/guix.texi
> @@ -15431,6 +15431,10 @@ use the size of the processors cache line.
>  @item @code{server-names-hash-bucket-max-size} (default: @code{#f})
>  Maximum bucket size for the server names hash tables.
>  
> +@item @code{extra-content} (default: @code{'()})
> +Extra content for the @code{http} block.  Should be a list of strings or
> +G-expressions.

I find it surprising that it’s a list rather than a string or

string-valued gexp. Thoughts?

Otherwise I think it’s very useful!

Thanks,

Ludo’.

Christopher Baines wrote 7 years ago

Recipients:(name . Ludovic Courtès)(address . ludo@gnu.org)(address . 30702@debbugs.gnu.org)

Message-ID:87in9ue046.fsf@cbaines.net

Ludovic Courtès <ludo@gnu.org> writes:

Toggle quote (32 lines)> Hello,
>
> Christopher Baines <mail@cbaines.net> skribis:
>
>> This helpful when adding content to the nginx configuration file, which isn't
>> supported by the record type used for the configuration.  For example, like
>> adding proxy_cache_path configuration.
>>
>> * gnu/packages/web.scm (<nginx-configuration>): Add new extra-content field.
>>   (nginx-configuration-extra-content): New field accessor.
>>   (default-nginx-config): Add support for the extra-content field.
>> * doc/guix.texi (NGINX): Document the new extra-content field.
>> ---
>>  doc/guix.texi        | 4 ++++
>>  gnu/services/web.scm | 9 +++++++--
>>  2 files changed, 11 insertions(+), 2 deletions(-)
>>
>> diff --git a/doc/guix.texi b/doc/guix.texi
>> index 057272df4..151bc7ddd 100644
>> --- a/doc/guix.texi
>> +++ b/doc/guix.texi
>> @@ -15431,6 +15431,10 @@ use the size of the processors cache line.
>>  @item @code{server-names-hash-bucket-max-size} (default: @code{#f})
>>  Maximum bucket size for the server names hash tables.
>>
>> +@item @code{extra-content} (default: @code{'()})
>> +Extra content for the @code{http} block.  Should be a list of strings or
>> +G-expressions.
>
> I find it surprising that it’s a list rather than a string or
> string-valued gexp.  Thoughts?

Lists are used as the type for other fields in related records. I chose
a list as it's easy to add things to, but thinking about it, that's
probably true for strings and gexps as well.

Saying it can be either a string or a gexp might be a little tricky, as
string operations wouldn't work on the gexp. My familiarity with
string-valued gexps is a little limited though, I've only just started
using file-append more, as I think that's how it works. How would you go
about adding say a string to a gexp?

Ludovic Courtès wrote 7 years ago

Recipients:(name . Christopher Baines)(address . mail@cbaines.net)(address . 30702@debbugs.gnu.org)

Message-ID:87h8pdnw8l.fsf@gnu.org

Christopher Baines <mail@cbaines.net> skribis:

Toggle quote (2 lines)

> Ludovic Courtès <ludo@gnu.org> writes:

[...]

Toggle quote (17 lines)>>> +@item @code{extra-content} (default: @code{'()})
>>> +Extra content for the @code{http} block.  Should be a list of strings or
>>> +G-expressions.
>>
>> I find it surprising that it’s a list rather than a string or
>> string-valued gexp.  Thoughts?
>
> Lists are used as the type for other fields in related records. I chose
> a list as it's easy to add things to, but thinking about it, that's
> probably true for strings and gexps as well.
>
> Saying it can be either a string or a gexp might be a little tricky, as
> string operations wouldn't work on the gexp. My familiarity with
> string-valued gexps is a little limited though, I've only just started
> using file-append more, as I think that's how it works. How would you go
> about adding say a string to a gexp?

You’d have to produce build-side code that will concatenate the strings:

;; Add extra content to CONFIG.

(let ((original (nginx-extra-content config)))

(nginx-configuration

(inherit config)

(extra-content #~(string-append #$original "\nextra extra stuff"))))

HTH!

Ludo’.

Christopher Baines wrote 7 years ago

[PATCH] services: nginx: Support extra content in the http block.

Recipients:(address . 30702@debbugs.gnu.org)

Message-ID:20180518085422.15849-1-mail@cbaines.net

This helpful when adding content to the nginx configuration file, which isn't
supported by the record type used for the configuration.  For example, like
adding proxy_cache_path configuration.

* gnu/packages/web.scm (<nginx-configuration>): Add new extra-content field.
  (nginx-configuration-extra-content): New field accessor.
  (default-nginx-config): Add support for the extra-content field.
* doc/guix.texi (NGINX): Document the new extra-content field.
---
 doc/guix.texi        | 4 ++++
 gnu/services/web.scm | 9 +++++++--
 2 files changed, 11 insertions(+), 2 deletions(-)

Toggle diff (58 lines)diff --git a/doc/guix.texi b/doc/guix.texi
index a12210db8..eaaf0e684 100644
--- a/doc/guix.texi
+++ b/doc/guix.texi
@@ -15786,6 +15786,10 @@ use the size of the processors cache line.
 @item @code{server-names-hash-bucket-max-size} (default: @code{#f})
 Maximum bucket size for the server names hash tables.
 
+@item @code{extra-content} (default: @code{""})
+Extra content for the @code{http} block.  Should be string or a string
+valued G-expression.
+
 @end table
 @end deffn
 
diff --git a/gnu/services/web.scm b/gnu/services/web.scm
index b336a8dd3..8f55dae5e 100644
--- a/gnu/services/web.scm
+++ b/gnu/services/web.scm
@@ -73,6 +73,7 @@
             nginx-configuration-upstream-blocks
             nginx-configuration-server-names-hash-bucket-size
             nginx-configuration-server-names-hash-bucket-max-size
+            nginx-configuration-extra-content
             nginx-configuration-file
 
             <nginx-server-configuration>
@@ -423,6 +424,8 @@
                                  (default #f))
   (server-names-hash-bucket-max-size nginx-configuration-server-names-hash-bucket-max-size
                                      (default #f))
+  (extra-content nginx-configuration-extra-content
+                 (default ""))
   (file          nginx-configuration-file         ;#f | string | file-like
                  (default #f)))
 
@@ -513,7 +516,8 @@ of index files."
                 (nginx log-directory run-directory
                  server-blocks upstream-blocks
                  server-names-hash-bucket-size
-                 server-names-hash-bucket-max-size)
+                 server-names-hash-bucket-max-size
+                 extra-content)
    (apply mixed-text-file "nginx.conf"
           (flatten
            "user nginx nginx;\n"
@@ -542,7 +546,8 @@ of index files."
            "\n"
            (map emit-nginx-upstream-config upstream-blocks)
            (map emit-nginx-server-config server-blocks)
-           "}\n"
+           extra-content
+           "\n}\n"
            "events {}\n"))))
 
 (define %nginx-accounts
-- 
2.17.0

Christopher Baines wrote 7 years ago

Recipients:(name . Ludovic Courtès)(address . ludo@gnu.org)(address . 30702@debbugs.gnu.org)

Message-ID:87muwx484h.fsf@cbaines.net

Ludovic Courtès <ludo@gnu.org> writes:

Toggle quote (32 lines)> Hello,
>
> Christopher Baines <mail@cbaines.net> skribis:
>
>> This helpful when adding content to the nginx configuration file, which isn't
>> supported by the record type used for the configuration.  For example, like
>> adding proxy_cache_path configuration.
>>
>> * gnu/packages/web.scm (<nginx-configuration>): Add new extra-content field.
>>   (nginx-configuration-extra-content): New field accessor.
>>   (default-nginx-config): Add support for the extra-content field.
>> * doc/guix.texi (NGINX): Document the new extra-content field.
>> ---
>>  doc/guix.texi        | 4 ++++
>>  gnu/services/web.scm | 9 +++++++--
>>  2 files changed, 11 insertions(+), 2 deletions(-)
>>
>> diff --git a/doc/guix.texi b/doc/guix.texi
>> index 057272df4..151bc7ddd 100644
>> --- a/doc/guix.texi
>> +++ b/doc/guix.texi
>> @@ -15431,6 +15431,10 @@ use the size of the processors cache line.
>>  @item @code{server-names-hash-bucket-max-size} (default: @code{#f})
>>  Maximum bucket size for the server names hash tables.
>>
>> +@item @code{extra-content} (default: @code{'()})
>> +Extra content for the @code{http} block.  Should be a list of strings or
>> +G-expressions.
>
> I find it surprising that it’s a list rather than a string or
> string-valued gexp.  Thoughts?

I've now got around to trying this out, and sent a patch that uses a

string, rather than a list.

Ludovic Courtès wrote 7 years ago

Recipients:(name . Christopher Baines)(address . mail@cbaines.net)(address . 30702@debbugs.gnu.org)

Message-ID:87wovzo01h.fsf@gnu.org

Hello,

Christopher Baines <mail@cbaines.net> skribis:

Toggle quote (9 lines)

> This helpful when adding content to the nginx configuration file, which isn't

> supported by the record type used for the configuration. For example, like

> adding proxy_cache_path configuration.

> * gnu/packages/web.scm (<nginx-configuration>): Add new extra-content field.

> (nginx-configuration-extra-content): New field accessor.

> (default-nginx-config): Add support for the extra-content field.

> * doc/guix.texi (NGINX): Document the new extra-content field.

[...]

Toggle quote (4 lines)

> +@item @code{extra-content} (default: @code{""})

> +Extra content for the @code{http} block. Should be string or a string

> +valued G-expression.

[...]

Toggle quote (12 lines)>     (apply mixed-text-file "nginx.conf"
>            (flatten
>             "user nginx nginx;\n"
> @@ -542,7 +546,8 @@ of index files."
>             "\n"
>             (map emit-nginx-upstream-config upstream-blocks)
>             (map emit-nginx-server-config server-blocks)
> -           "}\n"
> +           extra-content
> +           "\n}\n"
>             "events {}\n"))))

That doesn’t work if ‘extra-content’ is something like:

#~(string-append "foo" bar)

does it?

My understanding of the doc above was that it intends to allow this.

But maybe it doesn’t matter after all?

Thanks,

Ludo’.

Christopher Baines wrote 7 years ago

Recipients:(name . Ludovic Courtès)(address . ludo@gnu.org)(address . 30702@debbugs.gnu.org)

Message-ID:8736xt42l8.fsf@cbaines.net

Ludovic Courtès <ludo@gnu.org> writes:

Toggle quote (42 lines)> Hello,
>
> Christopher Baines <mail@cbaines.net> skribis:
>
>> This helpful when adding content to the nginx configuration file, which isn't
>> supported by the record type used for the configuration.  For example, like
>> adding proxy_cache_path configuration.
>>
>> * gnu/packages/web.scm (<nginx-configuration>): Add new extra-content field.
>>   (nginx-configuration-extra-content): New field accessor.
>>   (default-nginx-config): Add support for the extra-content field.
>> * doc/guix.texi (NGINX): Document the new extra-content field.
>
> [...]
>
>> +@item @code{extra-content} (default: @code{""})
>> +Extra content for the @code{http} block.  Should be string or a string
>> +valued G-expression.
>
> [...]
>
>>     (apply mixed-text-file "nginx.conf"
>>            (flatten
>>             "user nginx nginx;\n"
>> @@ -542,7 +546,8 @@ of index files."
>>             "\n"
>>             (map emit-nginx-upstream-config upstream-blocks)
>>             (map emit-nginx-server-config server-blocks)
>> -           "}\n"
>> +           extra-content
>> +           "\n}\n"
>>             "events {}\n"))))
>
> That doesn’t work if ‘extra-content’ is something like:
>
>   #~(string-append "foo" bar)
>
> does it?
>
> My understanding of the doc above was that it intends to allow this.
> But maybe it doesn’t matter after all?

So... I've finally got back around to looking at this, and as far as I
can see, it does work. extra-content is passed as one of the arguments
to mixed-text-file, which accepts G-exp things.

Ludovic Courtès wrote 7 years ago

Recipients:(name . Christopher Baines)(address . mail@cbaines.net)(address . 30702@debbugs.gnu.org)

Message-ID:87y3fkqskc.fsf@gnu.org

Christopher Baines <mail@cbaines.net> skribis:

Toggle quote (48 lines)> Ludovic Courtès <ludo@gnu.org> writes:
>
>> Hello,
>>
>> Christopher Baines <mail@cbaines.net> skribis:
>>
>>> This helpful when adding content to the nginx configuration file, which isn't
>>> supported by the record type used for the configuration.  For example, like
>>> adding proxy_cache_path configuration.
>>>
>>> * gnu/packages/web.scm (<nginx-configuration>): Add new extra-content field.
>>>   (nginx-configuration-extra-content): New field accessor.
>>>   (default-nginx-config): Add support for the extra-content field.
>>> * doc/guix.texi (NGINX): Document the new extra-content field.
>>
>> [...]
>>
>>> +@item @code{extra-content} (default: @code{""})
>>> +Extra content for the @code{http} block.  Should be string or a string
>>> +valued G-expression.
>>
>> [...]
>>
>>>     (apply mixed-text-file "nginx.conf"
>>>            (flatten
>>>             "user nginx nginx;\n"
>>> @@ -542,7 +546,8 @@ of index files."
>>>             "\n"
>>>             (map emit-nginx-upstream-config upstream-blocks)
>>>             (map emit-nginx-server-config server-blocks)
>>> -           "}\n"
>>> +           extra-content
>>> +           "\n}\n"
>>>             "events {}\n"))))
>>
>> That doesn’t work if ‘extra-content’ is something like:
>>
>>   #~(string-append "foo" bar)
>>
>> does it?
>>
>> My understanding of the doc above was that it intends to allow this.
>> But maybe it doesn’t matter after all?
>
> So... I've finally got back around to looking at this, and as far as I
> can see, it does work. extra-content is passed as one of the arguments
> to mixed-text-file, which accepts G-exp things.

Alright, sounds good then!

Thanks,

Ludo’.

Christopher Baines wrote 7 years ago

Recipients:(name . Ludovic Courtès)(address . ludo@gnu.org)(address . 30702-done@debbugs.gnu.org)

Message-ID:87r2lb3gd2.fsf@cbaines.net

Ludovic Courtès <ludo@gnu.org> writes:

Toggle quote (2 lines)

> Alright, sounds good then!

Great, I've pushed this patch now :)

Closed

Your comment

This issue is archived.

To comment on this conversation send an email to 30702@debbugs.gnu.org

To respond to this issue using the mumi CLI, first switch to it

mumi current 30702

Then, you may apply the latest patchset in this issue (with sign off)

mumi am -- -s

Or, compose a reply to this issue

mumi compose

Or, send patches to this issue

mumi send-email *.patch

You may also tag this issue. See list of standard tags. For example, to set the confirmed and easy tags

mumi command -t +confirmed -t +easy

Or, remove the moreinfo tag and set the help tag

mumi command -t -moreinfo -t +help

is:open	open issues
is:done	closed issues
submitter:<who>	search issue submitter
author:<who>	search by message author
date:yesterday..now	search by issue date
mdate:3m..2d	search by message date